======================================================================== Metrowerks ZipSight HTTP Server Release Notes ======================================================================== Version: 1.2 Date: 01/27/99 Author: Pedro Larios ======================================================================== This app is an http server that allows the user to view html docs inside a zip or jar file, preserving all the links within the docs. This is particularly useful on the Mac where the filename limit of 31 characters renders most javadoc documentation useless. However, since this application is 100% pure Java, it will (supposedly) run on any platform which has a 1.1 or later capable VM. It has been tested on Windows and Mac only. When the application is launched, a window will come up which will have three buttons: "configure", "start", and "quit". Below the buttons are the server address and status information. The configure button brings up a configuration panel that allows the user to specify the server options. The configuration panel has two tabs. The "general" tab contains the server path and port number. The "security" tab contains options to enable logging of all http transactions, as well as options to start the server automatically on launch and to disallow remote connections. General settings ---------------- The server path points to a directory on the host machine containing the zip/jar files. All http requests the server gets will be relative to this server path. For example, if the server receives an http request of the form: http://127.0.0.1/foo/bar/MyDocs.zip/index.html the server will look for the file MyDocs.zip in the path: server_path/foo/bar/ IMPORTANT NOTE: Although http requests that attempt to go above the server path (i.e. those of the form "http://127.0.0.1/../../file.html") will always be denied (the server will return a "403 Forbidden" error message), all files inside the server path will be visible. Therefore, be careful not to set the server path to a directory containing files that you do not wish to make available to the network. The server port is the port number on which the server listens for connections. By default, this is set to port 80 (the well-known port number for WWW-HTTP) but can be changed to any valid port number. Security settings ----------------- The check box marked "Keep a log of server activity" determines whether or not ZipSight will keep a log of all server transactions. This log will be saved in a text file called "ZipSight.log" which will be created in the same folder as the one the ZipSight application resides in. The check box marked "Start server on launch" determines whether or not the server should start when ZipSight is launched. This will use the current configuration settings for server path and port number so before setting this option make sure the server path is not pointing to some folder you do not wish to make visible on the network! If the server path is not specified in the zipsight.properties file, the path defaults to the java user.dir property. Usually, this will be the folder where ZipSight resides. The check box marked "Do not allow remote connections" determines whether or not ZipSight will allow connections from remote machines. If this check box is set, ZipSight will only allow connections originating from the local machine. Instructions ------------ On pressing the start button the server will begin listening for a connection on the port number specified in the configuration panel. The status field should change from "stopped" to "running". The server address field should show the machine's HTTP address. This field is not editable, but it appears to let the user know what the server's address is. The text from this field can be copied and pasted into a WWW-browser to specify the correct URL. Once the server is started, it is ready to begin serving http requests. Fire up your favorite WWW browser and enter the URL for the file(s) you wish to browse. URLs to the server should be constructed as follows: * to specify files within a zip: http://IP:PORT/path1/filename.zip/path2/filename.html IP:PORT is the address where the server is listening (displayed in the "Server address" field). "path1" is the path to the file "filename.zip". This path will be appended to the server path by ZipSight in order to locate the file "filename.zip". It is, of course, optional. "filename.zip" is the name of the zip/jar file being served. "path2" is the path inside the zip/jar file used to find the html document "filename.html". * to specify files outside a zip: http://IP:PORT/path/filename.html * If a filename is not specified, ZipSight will search for a default index inside the zip file (index.html). Thus, the following URL will display the file "index.html" located inside filename.zip. http://IP:PORT/filename.zip/ If there is no "index.html" file within the zip file, ZipSight will generate an index of the contents of the zip file, with hyper links to all html files it finds inside the zip. ======================================================================== New Features in This Version ======================================================================== 1.2 * Added an option to disallow remote connections. * Updated to Swing 1.1b3 1.1 * Added pref to autostart the server on launch. * This version of ZipSight requires Swing version 1.0.3 or later. Make sure the swing libraries reside in the Java VM's classpath before running the application. * ZipSight now saves the configuration options to disk in a file called "zipsight.properties" so they can be remembered between sessions. Currently, it saves only the following properties: screen position, server port number, server home, whether logging should be enabled, and whether or not the server should start as soon as ZipSight is launched. The properties file is a text file so it can be edited by the user. 1.0 * N/A ======================================================================== Bugs Fixed in This Version ======================================================================== * 1.2b2 Fixed a bug where the internal server path was being corrupted after changing it in the ZipSight config panel. * 1.1b3 On Mac, it was not possible to copy the server address from the text field using cmd-C. Menu items have been added which enable the user to select and copy this text. To do this, use "Edit->Select" and/or "Edit->Copy". ======================================================================== Known Bugs and Incompatibilities ======================================================================== * none. ======================================================================== Additional Notes ======================================================================== * As mentioned above, this application requires a 1.1 or greater VM. On the Mac, you should use MRJ 2.1 or later. On windows, JDK/JRE version 1.2 is recommended although it has been tested on JDK 1.1.6 and later. ======================================================================== Contacting Metrowerks ======================================================================== For bug reports, technical questions, and suggestions, please use the forms in the Release Notes folder on the CD, and send them to support@metrowerks.com See the CodeWarrior on the Nets document in the Release Notes folder for more contact information, including a list of Internet news groups, on-line services, and patch and update sites. ======================================================================== CodeWarrior Java Engineers Metrowerks Corporation